RTD now integrated with this repo, with builds for PRs enabled. Should work on next push to this branch.

@ntessore private repos not supported, so guess we'll have to wait on this

Ah, sure. I will disable PR builds on RTD. We can still build locally and as part of CI.

So I'm going to leave this for now. Essentially, what I've done is make a start on the documentation - with a focus on the API documentation. For ease, I'm incorporating everything public from the heracles module (although, of course, we can selectively choose with mkdocstrings). As a result, I've made things private which shouldn't be called by an external user.

I've also added docstrings to all functions/classes/modules. So in general you'll see a lot of _description_ and _summary_ placeholders. I haven't time/knowledge to fix each of those.

I've gone through and added typing to the best of my ability. For those where I've been unsure I've put typing.TypeVar("Unknown") as a placeholder - I decided not to use typing.Any as that disables type checking, and in general we want that.

I looked into adding the notebook as a standalone page using mkdocs-jupyter, but the plugin seems to no longer work.

I've decided to use MkDocs rather than sphinx as an experiment. It should mean you can just write markdown files in the docs folder and everything should work out the box. MkDocs has a similar plugin ecosystem to sphinx.

I've also included the README.md as the main index.html of the website. I've added some markdown badges to the README.md as well, to let others know what the code is about.